<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qdoc-manual-markupcmds.qdoc -->
  <title>Miscellaneous | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Miscellaneous</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
  <link rel="prev" href="11-qdoc-commands-specialcontent.html" />
  <link rel="next" href="21-0-qdoc-creating-dita-maps.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="11-qdoc-commands-specialcontent.html">Special Content</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="21-0-qdoc-creating-dita-maps.html">Creating DITA Maps</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#annotatedlist">\annotatedlist</a></li>
<li class="level1"><a href="#generatelist">\generatelist</a></li>
<li class="level2"><a href="#annotatedclasses"><code>annotatedclasses</code></a></li>
<li class="level2"><a href="#annotatedexamples"><code>annotatedexamples</code></a></li>
<li class="level2"><a href="#annotatedattributions"><code>annotatedattributions</code></a></li>
<li class="level2"><a href="#classes-op-lt-op-prefix-op-gt-op"><code>classes &lt;prefix&gt;</code></a></li>
<li class="level2"><a href="#classesbymodule"><code>classesbymodule</code></a></li>
<li class="level2"><a href="#qmltypesbymodule"><code>qmltypesbymodule</code></a></li>
<li class="level2"><a href="#jstypesbymodule"><code>jstypesbymodule</code></a></li>
<li class="level2"><a href="#examplefiles-op-op-regular-expression-op-op"><code>examplefiles [regular_expression]</code></a></li>
<li class="level2"><a href="#exampleimages-op-op-regular-expression-op-op"><code>exampleimages [regular_expression]</code></a></li>
<li class="level2"><a href="#functionindex"><code>functionindex</code></a></li>
<li class="level2"><a href="#legalese"><code>legalese</code></a></li>
<li class="level2"><a href="#overviews"><code>overviews</code></a></li>
<li class="level2"><a href="#attributions"><code>attributions</code></a></li>
<li class="level2"><a href="#related"><code>related</code></a></li>
<li class="level1"><a href="#if">\if</a></li>
<li class="level1"><a href="#endif">\endif</a></li>
<li class="level1"><a href="#else">\else</a></li>
<li class="level1"><a href="#include">\include</a></li>
<li class="level2"><a href="#include-filename-snippet-identifier">\include filename snippet-identifier</a></li>
<li class="level1"><a href="#meta">\meta</a></li>
<li class="level1"><a href="#noautolist">\noautolist</a></li>
<li class="level1"><a href="#omit">\omit</a></li>
<li class="level1"><a href="#raw-avoid">\raw (avoid)</a></li>
<li class="level1"><a href="#unicode">\unicode</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Miscellaneous</h1>
<span class="subtitle"></span>
<!-- $$$12-0-qdoc-commands-miscellaneous.html-description -->
<div class="descr"> <a name="details"></a>
<p>These commands provide miscellaneous functions connected to the visual appearance of the documentation, and to the process of generating the documentation.</p>
<a name="annotatedlist-command"></a><a name="annotatedlist"></a>
<h2 id="annotatedlist">\annotatedlist</h2>
<p>The \annotatedlist command expands to a list of the members of a group, each member listed with its <i>brief</i> text. Below is an example from the Qt Reference Documentation:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
      \section1 Drag and Drop Classes

      These classes deal with drag and drop and the necessary mime type
      encoding and decoding<span class="operator">.</span>

      \annotatedlist draganddrop

  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>This generates a list of all the C++ classes and/or QML types in the <i>draganddrop</i> group. A C++ class or QML type in the <i>draganddrop</i> group will have <i>\ingroup draganddrop</i> in its <i>\class</i> or <i>\qmltype</i> comment.</p>
<a name="generatelist-command"></a><a name="generatelist"></a>
<h2 id="generatelist">\generatelist</h2>
<p>The \generatelist command expands to a list of links to the documentation entities in a group. Below is an example from the Qt Reference Documentation:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \page classes<span class="operator">.</span>html
      \title All Classes

      For a shorter list that only includes the most
      frequently used classes<span class="operator">,</span> see \l{<span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="char">'s Main Classes}.

      \generatelist classes Q
  * /
  </span>

</pre>
<p>This generates the <i>All Classes</i> page. The command accepts the following arguments:</p>
<a name="table-example"></a><a name="annotatedclasses"></a>
<h3 id="annotatedclasses"><code>annotatedclasses</code></h3>
<p>The <code>annotatedclasses</code> argument provides a table containing the names of all the classes, and a description of each class. Each class name is a link to the class's reference documentation. For example:</p>
<div class="table"><table class="generic">
 <tr valign="top" class="odd"><td ><a href="../qtwidgets/qdial.html">QDial</a></td><td >Rounded range control (like a speedometer or potentiometer)</td></tr>
<tr valign="top" class="even"><td ><a href="../qtwidgets/qdialog.html">QDialog</a></td><td >The base class of dialog windows</td></tr>
<tr valign="top" class="odd"><td ><a href="../qtcore/qdir.html">QDir</a></td><td >Access to directory structures and their contents</td></tr>
</table></div>
<p>A C++ class is documented with the <a href="13-qdoc-commands-topics.html#class-command">\class</a> command. The annotation for the class is taken from the argument of the class comment's <a href="11-qdoc-commands-specialcontent.html#brief-command">\brief</a> command.</p>
<a name="annotatedexamples"></a>
<h3 id="annotatedexamples"><code>annotatedexamples</code></h3>
<p>The <code>annotatedexamples</code> argument provides a complete list of all examples as a set of tables containing the titles of all the examples, and a description of each example. Each title is a link to the example's documentation.</p>
<p>A separate table for each module (that has documented examples) is generated, provided that the module has defined a navigation.landingpage configuration variable. The <i>landingpage</i> variable is used as a title for a header that precedes each table.</p>
<a name="annotatedattributions"></a>
<h3 id="annotatedattributions"><code>annotatedattributions</code></h3>
<p>The <code>annotatedattributions</code> argument provides a complete list of all attributions as a set of tables containing the titles of all the attributions, and a description of each attribution. Each title is a link to the attribution's page.</p>
<p>A separate table for each module (that has attributions) is generated, provided that the module has defined a navigation.landingpage configuration variable. The <i>landingpage</i> variable is used as a title for a header that precedes each table.</p>
<a name="list-example"></a><a name="classes-op-lt-op-prefix-op-gt-op"></a>
<h3 id="classes-op-lt-op-prefix-op-gt-op"><code>classes &lt;prefix&gt;</code></h3>
<p>The <code>classes</code> argument provides a complete alphabetical list of the classes. The second argument, <code>&lt;prefix&gt;</code>, is the common prefix for the class names. The class names will be sorted on the character that follows the common prefix. e.g&#x2e; The common prefix for the Qt classes is <code>Q</code>. The common prefix argument is optional. If no common prefix is provided, the class names will be sorted on their first character.</p>
<p>Each class name becomes a link to the class's reference documentation. This command is used to generate the <i>All Classes</i> page this way:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \page classes<span class="operator">.</span>html
      \title All Classes
      \ingroup classlists

      \brief Alphabetical list of classes<span class="operator">.</span>

      This is a list of all <span class="type"><a href="../qtcore/qt.html">Qt</a></span> classes<span class="operator">.</span> For classes that
      have been deprecated<span class="operator">,</span> see the \l{Obsolete Classes}
      list<span class="operator">.</span>

      \generatelist classes Q
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>A C++ class is documented with the <a href="13-qdoc-commands-topics.html#class-command">\class</a> command.</p>
<a name="classesbymodule"></a>
<h3 id="classesbymodule"><code>classesbymodule</code></h3>
<p>When this argument is used, a second argument is required, which specifies the module whose classes are to be listed. QDoc generates a table containing those classes. Each class is listed with the text of its <a href="11-qdoc-commands-specialcontent.html#brief-command">\brief</a> command.</p>
<p>For example, this command can be used on a module page as follows:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \page phonon<span class="operator">-</span>module<span class="operator">.</span>html
      \module Phonon
      \title Phonon Module
      \ingroup modules

      \brief Contains namespaces and classes <span class="keyword">for</span> multimedia functionality<span class="operator">.</span>

      \generatelist{classesbymodule Phonon}

  <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>Each class that is a member of the specified module must be marked with the <a href="19-qdoc-commands-grouping.html#inmodule-command">\inmodule</a> command in its \class comment.</p>
<a name="qmltypesbymodule"></a>
<h3 id="qmltypesbymodule"><code>qmltypesbymodule</code></h3>
<p>Similar to <code>classesbymodule</code> argument, but used for listing the QML types from the QML module specified with the second argument.</p>
<p><b>Note: </b>Support for this argument was introduced in QDoc 5.6&#x2e;</p><a name="jstypesbymodule"></a>
<h3 id="jstypesbymodule"><code>jstypesbymodule</code></h3>
<p>Similar to <code>classesbymodule</code> argument, but used for listing the JavaScript types from the module specified with the second argument.</p>
<p><b>Note: </b>Support for this argument was introduced in QDoc 5.6&#x2e;</p><a name="examplefiles-op-op-regular-expression-op-op"></a>
<h3 id="examplefiles-op-op-regular-expression-op-op"><code>examplefiles [regular_expression]</code></h3>
<p>The <code>examplefiles</code> argument lists the files that are part of an example project. The optional second argument is a regular expression; if provided, only the files whose path matches with the regular expression are listed.</p>
<p>The <code>examplefiles</code> argument can be only used within example documentation (see <a href="13-qdoc-commands-topics.html#example-command">\example</a>), and is typically used together with the <a href="12-0-qdoc-commands-miscellaneous.html#noautolist-command">\noautolist</a> command.</p>
<a name="exampleimages-op-op-regular-expression-op-op"></a>
<h3 id="exampleimages-op-op-regular-expression-op-op"><code>exampleimages [regular_expression]</code></h3>
<p>The <code>exampleimages</code> argument lists the images that are part of an example project. The optional second argument is a regular expression; if provided, only the image files whose path matches with the regular expression are listed.</p>
<p>The <code>exampleimages</code> argument can be only used within example documentation (see <a href="13-qdoc-commands-topics.html#example-command">\example</a>), and is typically used together with the <a href="12-0-qdoc-commands-miscellaneous.html#noautolist-command">\noautolist</a> command.</p>
<a name="functionindex"></a>
<h3 id="functionindex"><code>functionindex</code></h3>
<p>The <code>functionindex</code> argument provides a complete alphabetical list of all the documented member functions. It is normally used only to generate the <i>Qt function index</i> page this way:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \page functions<span class="operator">.</span>html
      \title All Functions
      \ingroup funclists

      \brief All documented <span class="type"><a href="../qtcore/qt.html">Qt</a></span> functions listed alphabetically with a
      link to where each one is declared<span class="operator">.</span>

      This is the list of all documented member functions and global
      functions in the <span class="type"><a href="../qtcore/qt.html">Qt</a></span> API<span class="operator">.</span> Each function has a link to the
      <span class="keyword">class</span> <span class="keyword">or</span> header file where it is declared and documented<span class="operator">.</span>

      \generatelist functionindex
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<a name="legalese"></a>
<h3 id="legalese"><code>legalese</code></h3>
<p>The <code>legalese</code> argument tells QDoc to generate a list of licenses in the current documentation project. Each license is identified using the <a href="11-qdoc-commands-specialcontent.html#legalese-command">\legalese</a> command.</p>
<a name="overviews"></a>
<h3 id="overviews"><code>overviews</code></h3>
<p>The <code>overviews</code> argument is used to tell QDoc to generate a list by concatenating the contents of all the <a href="13-qdoc-commands-topics.html#group-command">\group</a> pages. Qt uses it to generate the <i>overviews</i> page this way:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \page overviews<span class="operator">.</span>html

      \title All Overviews and HOWTOs

      \generatelist overviews
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<a name="attributions"></a>
<h3 id="attributions"><code>attributions</code></h3>
<p>The <code>attributions</code> argument is used to tell QDoc to generate a list of attributions in the documentation.</p>
<a name="related"></a>
<h3 id="related"><code>related</code></h3>
<p>The <code>related</code> argument is used in combination with the <a href="13-qdoc-commands-topics.html#group-command">\group</a> and <a href="19-qdoc-commands-grouping.html#ingroup-command">\ingroup</a> commands to list all the overviews related to a specified group. For example, the page for the <i>Programming with Qt</i> page is generated this way:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \group qt<span class="operator">-</span>basic<span class="operator">-</span>concepts
      \title Programming with <span class="type"><a href="../qtcore/qt.html">Qt</a></span>

      \brief The basic architecture of the <span class="type"><a href="../qtcore/qt.html">Qt</a></span> cross<span class="operator">-</span>platform application and UI framework<span class="operator">.</span>

      <span class="type"><a href="../qtcore/qt.html">Qt</a></span> is a cross<span class="operator">-</span>platform application and UI framework <span class="keyword">for</span>
      writing web<span class="operator">-</span>enabled applications <span class="keyword">for</span> desktop<span class="operator">,</span> mobile<span class="operator">,</span> and
      embedded operating systems<span class="operator">.</span> This page contains links to
      articles and overviews explaining key components and
      techniuqes used in <span class="type"><a href="../qtcore/qt.html">Qt</a></span> development<span class="operator">.</span>

      \generatelist {related}
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>Each page listed on this group page contains the command:</p>
<pre class="cpp">

  \ingroup qt<span class="operator">-</span>basic<span class="operator">-</span>concepts

</pre>
<a name="if-command"></a><a name="if"></a>
<h2 id="if">\if</h2>
<p>The \if command and the corresponding \endif command enclose parts of a QDoc comment that only will be included if the condition specified by the command's argument is true.</p>
<p>The command reads the rest of the line and parses it as an C++ #if statement.</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \<span class="keyword">if</span> defined(opensourceedition)

      \note This edition is <span class="keyword">for</span> the development of
      \l{<span class="type"><a href="../qtcore/qt.html">Qt</a></span> Open Source Edition} {Free and Open Source}
      software only; see \l{<span class="type"><a href="../qtcore/qt.html">Qt</a></span> Commercial Editions}<span class="operator">.</span>

      \endif
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>This QDoc comment will only be rendered if the <code>opensourceedition</code> preprocessor symbol is defined, and specified in the <a href="22-qdoc-configuration-generalvariables.html#defines-variable">defines</a> variable in the configuration file to make QDoc process the code within #ifdef and #endif:</p>
<pre class="cpp">

  defines <span class="operator">=</span> opensourceedition

</pre>
<p>You can also define the preprocessor symbol manually on the command line. For more information see the documentation of the <a href="22-qdoc-configuration-generalvariables.html#defines-variable">defines</a> variable.</p>
<p>See also <a href="12-0-qdoc-commands-miscellaneous.html#endif-command">\endif</a>, <a href="12-0-qdoc-commands-miscellaneous.html#else-command">\else</a>, <a href="22-qdoc-configuration-generalvariables.html#defines-variable">defines</a> and <a href="22-qdoc-configuration-generalvariables.html#falsehoods-variable">falsehoods</a>.</p>
<a name="endif-command"></a><a name="endif"></a>
<h2 id="endif">\endif</h2>
<p>The \endif command and the corresponding \if command enclose parts of a QDoc comment that will be included if the condition specified by the <a href="12-0-qdoc-commands-miscellaneous.html#if-command">\if</a> command's argument is true.</p>
<p>For more information, see the documentation of the <a href="12-0-qdoc-commands-miscellaneous.html#if-command">\if</a> command.</p>
<p>See also <a href="12-0-qdoc-commands-miscellaneous.html#if-command">\if</a>, <a href="12-0-qdoc-commands-miscellaneous.html#else-command">\else</a>, <a href="22-qdoc-configuration-generalvariables.html#defines-variable">defines</a> and <a href="22-qdoc-configuration-generalvariables.html#falsehoods-variable">falsehoods</a>.</p>
<a name="else-command"></a><a name="else"></a>
<h2 id="else">\else</h2>
<p>The \else command specifies an alternative if the condition in the <a href="12-0-qdoc-commands-miscellaneous.html#if-command">\if</a> command is false.</p>
<p>The \else command can only be used within <a href="12-0-qdoc-commands-miscellaneous.html#if-command">\if..&#x2e;\endif</a> commands, but is useful when there is only two alternatives.</p>
<a name="include-command"></a><a name="include"></a>
<h2 id="include">\include</h2>
<p>The \include command sends all or part of the file specified by its first argument to the QDoc input stream to be processed as a QDoc comment snippet.</p>
<p>The command is useful when some snippet of commands or text is to be used in multiple places in the documentation. Use the \include command wherever you want to insert a snippet into the documentation. The file containing the snippet to include, must be located under the path(s) listed in the <a href="22-qdoc-configuration-generalvariables.html#sourcedirs-variable">sourcedirs</a> or <a href="22-qdoc-configuration-generalvariables.html#exampledirs-variable">exampledirs</a> QDoc configuration variable. It can be either any source file parsed by QDoc (or even the same one where \include command is used), or any other text file. To store snippets in a separate file that is not meant to be parsed by QDoc, use a file extension that is not listed in <a href="22-qdoc-configuration-generalvariables.html#sources-fileextensions-variable">sources.fileextensions</a>; for example, <code>.qdocinc</code>.</p>
<p>The command can have either one or two arguments. The first argument is always a file name. The contents of the file must be QDoc input, in other words, a sequence of QDoc commands and text, but without the enclosing QDoc comment <code>/</code><code>*!</code> ..&#x2e; <code>*</code><code>/</code> delimiters. If you want to include the entire named file, don't use the second argument. If you want to include only part of the file, see the <a href="12-0-qdoc-commands-miscellaneous.html#2-argument-form">two argument form</a> below. Here is an example of the one argument form:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \page corefeatures<span class="operator">.</span>html
      \title Core Features

      \<span class="keyword">include</span> examples<span class="operator">/</span>signalandslots<span class="operator">.</span>qdocinc
      \<span class="keyword">include</span> examples<span class="operator">/</span>objectmodel<span class="operator">.</span>qdocinc
      \<span class="keyword">include</span> examples<span class="operator">/</span>layoutmanagement<span class="operator">.</span>qdocinc
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>QDoc renders this page <a href="corefeatures.html">as shown here</a>.</p>
<a name="2-argument-form"></a><a name="include-filename-snippet-identifier"></a>
<h3 id="include-filename-snippet-identifier">\include filename snippet-identifier</h3>
<p>It is a waste of time to make a separate <code>.qdocinc</code> file for every QDoc include snippet you want to use in multiple places in the documentation, especially given that you probably have to put the copyright/license notice in every one of these files. So if you have a large number of snippets to be included, you can put them all in a single file if you want, and surround each one with:</p>
<pre class="cpp">

      <span class="comment">//! [snippet-id1]</span>

         <span class="type">QDoc</span> commands and text<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

  <span class="comment">//! [snippet-id1]</span>

      <span class="comment">//! [snippet-id2]</span>

         More <span class="type">QDoc</span> commands and text<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

  <span class="comment">//! [snippet-id2]</span>

</pre>
<p>Then you can use the two-argument form of the command:</p>
<pre class="cpp">

  \input examples<span class="operator">/</span>signalandslots<span class="operator">.</span>qdocinc snippet<span class="operator">-</span>id2
  \input examples<span class="operator">/</span>objectmodel<span class="operator">.</span>qdocinc another<span class="operator">-</span>snippet<span class="operator">-</span>id

</pre>
<p>It works as expected. The sequence of QDoc commands and text found between the two tags with the same name as the second argument is sent to the QDoc input stream. You can even have nested snippets.</p>
<p><b>Note: </b>Snippet identifiers work also within documentation comment (/*! .. */) blocks, so it's not necessary to use a separate <code>.qdocinc</code> file. When processing a comment block, QDoc removes any <code>//!</code> comment lines from the generated output.</p><a name="meta-command"></a><a name="meta"></a>
<h2 id="meta">\meta</h2>
<p>The \meta command is mainly used for including metadata in DITA XML files. It is also used for adding metadata to example documentation, and when generating HTML output for specifying the <i>maintainer(s)</i> of a C++ class.</p>
<p>The command has two arguments: the first argument is the name of the metadata attribute, and the second argument is the value for the attribute. Each argument should be enclosed in curly brackets, as shown in this example:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \<span class="keyword">class</span> <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span>
      \brief The <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span> <span class="keyword">class</span> is the base <span class="keyword">class</span> of all user interface objects<span class="operator">.</span>

      \ingroup basicwidgets

      \meta {technology} {User Interface}
      \meta {platform} {macOS <span class="number">10.6</span>}
      \meta {platform} {MeeGo}
      \meta {audience} {user}
      \meta {audience} {programmer}
      \meta {audience} {designer}
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>When running QDoc to generate HTML, the example above will have no effect on the generated output, but if you run QDoc to generate DITA XML, the example will generate the following:</p>
<pre class="cpp">

  <span class="operator">&lt;</span><span class="operator">?</span>xml version<span class="operator">=</span><span class="string">&quot;1.0&quot;</span> encoding<span class="operator">=</span><span class="string">&quot;UTF-8&quot;</span><span class="operator">?</span><span class="operator">&gt;</span>
  <span class="operator">&lt;</span><span class="operator">!</span>DOCTYPE cxxClass PUBLIC <span class="string">&quot;-//NOKIA//DTD DITA C++ API Class Reference Type v0.6.0//EN&quot;</span> <span class="string">&quot;dtd/cxxClass.dtd&quot;</span><span class="operator">&gt;</span>
  <span class="operator">&lt;</span><span class="operator">!</span><span class="operator">-</span><span class="operator">-</span>qwidget<span class="operator">.</span>cpp<span class="operator">-</span><span class="operator">-</span><span class="operator">&gt;</span>
  <span class="operator">&lt;</span>cxxClass id<span class="operator">=</span><span class="string">&quot;id-9a14268e-6b09-4eee-b940-21a00a0961df&quot;</span><span class="operator">&gt;</span>
     <span class="operator">&lt;</span>apiName<span class="operator">&gt;</span><span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span><span class="operator">&lt;</span><span class="operator">/</span>apiName<span class="operator">&gt;</span>
     <span class="operator">&lt;</span>shortdesc<span class="operator">&gt;</span>the <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span> <span class="keyword">class</span> is the base <span class="keyword">class</span> of all user interface objects<span class="operator">.</span><span class="operator">&lt;</span><span class="operator">/</span>shortdesc<span class="operator">&gt;</span>
     <span class="operator">&lt;</span>prolog<span class="operator">&gt;</span>
         <span class="operator">&lt;</span>author<span class="operator">&gt;</span><span class="type"><a href="../qtcore/qt.html">Qt</a></span> Development Frameworks<span class="operator">&lt;</span><span class="operator">/</span>author<span class="operator">&gt;</span>
         <span class="operator">&lt;</span>publisher<span class="operator">&gt;</span><span class="type"><a href="../qtcore/qt.html">Qt</a></span> Project<span class="operator">&lt;</span><span class="operator">/</span>publisher<span class="operator">&gt;</span>
         <span class="operator">&lt;</span>copyright<span class="operator">&gt;</span>
             <span class="operator">&lt;</span>copyryear year<span class="operator">=</span><span class="string">&quot;2020&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
             <span class="operator">&lt;</span>copyrholder<span class="operator">&gt;</span><span class="type"><a href="../qtcore/qt.html">Qt</a></span> Project<span class="operator">&lt;</span><span class="operator">/</span>copyrholder<span class="operator">&gt;</span>
         <span class="operator">&lt;</span><span class="operator">/</span>copyright<span class="operator">&gt;</span>
         <span class="operator">&lt;</span>permissions view<span class="operator">=</span><span class="string">&quot;all&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
         <span class="operator">&lt;</span>metadata<span class="operator">&gt;</span>
             <span class="operator">&lt;</span>audience type<span class="operator">=</span><span class="string">&quot;designer&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
             <span class="operator">&lt;</span>audience type<span class="operator">=</span><span class="string">&quot;programmer&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
             <span class="operator">&lt;</span>audience type<span class="operator">=</span><span class="string">&quot;user&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
             <span class="operator">&lt;</span>category<span class="operator">&gt;</span>Class reference<span class="operator">&lt;</span><span class="operator">/</span>category<span class="operator">&gt;</span>
             <span class="operator">&lt;</span>prodinfo<span class="operator">&gt;</span>
                 <span class="operator">&lt;</span>prodname<span class="operator">&gt;</span><span class="type"><a href="../qtcore/qt.html">Qt</a></span> Reference Documentation<span class="operator">&lt;</span><span class="operator">/</span>prodname<span class="operator">&gt;</span>
                 <span class="operator">&lt;</span>vrmlist<span class="operator">&gt;</span>
                     <span class="operator">&lt;</span>vrm version<span class="operator">=</span><span class="string">&quot;4&quot;</span> release<span class="operator">=</span><span class="string">&quot;7&quot;</span> modification<span class="operator">=</span><span class="string">&quot;3&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
                 <span class="operator">&lt;</span><span class="operator">/</span>vrmlist<span class="operator">&gt;</span>
                 <span class="operator">&lt;</span>component<span class="operator">&gt;</span><span class="type"><a href="../qtgui/qtgui-module.html">QtGui</a></span><span class="operator">&lt;</span><span class="operator">/</span>component<span class="operator">&gt;</span>
             <span class="operator">&lt;</span><span class="operator">/</span>prodinfo<span class="operator">&gt;</span>
             <span class="operator">&lt;</span>othermeta name<span class="operator">=</span><span class="string">&quot;platform&quot;</span> content<span class="operator">=</span><span class="string">&quot;MeeGo&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
             <span class="operator">&lt;</span>othermeta name<span class="operator">=</span><span class="string">&quot;platform&quot;</span> content<span class="operator">=</span><span class="string">&quot;macOS 10.6&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
             <span class="operator">&lt;</span>othermeta name<span class="operator">=</span><span class="string">&quot;technology&quot;</span> content<span class="operator">=</span><span class="string">&quot;User Interface&quot;</span><span class="operator">/</span><span class="operator">&gt;</span>
         <span class="operator">&lt;</span><span class="operator">/</span>metadata<span class="operator">&gt;</span>
     <span class="operator">&lt;</span><span class="operator">/</span>prolog<span class="operator">&gt;</span>

</pre>
<p>In the example output, several values have been set using default values obtained from the QDoc configuration file. See <a href="21-3-qt-dita-xml-output.html">Generating DITA XML Output</a> for details.</p>
<p><b>Example Metadata</b></p>
<p>Another use for \meta command is to include metadata (tags) in <a href="13-qdoc-commands-topics.html#example-command">\example</a> documentation. By default, QDoc generates example tags based on the example's <a href="20-qdoc-commands-namingthings.html#title-command">\title</a> and module name. These tags are displayed in Qt Creator's Welcome mode, helping users navigate the list of examples.</p>
<p>Additional tags can be created with <code>\\meta {tag} {tag1,[tag2,..&#x2e;]}</code>. For example:</p>
<pre class="cpp plain">

  / *!
      \example helloworld
      \title Hello World Example
      \meta {tag} {tutorial,basic}
  * /

</pre>
<p>This would result in the following tags: <i>tutorial,basic,hello,world</i>. Common words such as <i>example</i> are ignored.</p>
<p><b>Example Install Paths</b></p>
<p>The \meta command combined with an argument <code>installpath</code> specifies the location of an installed example. This value overrides the one that is set using the <code>examplesinstallpath</code> configuration variable.</p>
<pre class="cpp plain">

  / *!
      \example helloworld
      \title Hello World Example
      \meta {installpath} {tutorials}
  * /

</pre>
<p>See also <a href="qtgui-qdocconf.html#examplesinstallpath">examplesinstallpath</a>.</p>
<a name="noautolist-command"></a><a name="noautolist"></a>
<h2 id="noautolist">\noautolist</h2>
<p>The \noautolist command indicates that the annotated list of C++ classes or QML types, which is automatically generated at the bottom of the C++ or QML module page should be omitted, because the classes or types have been listed manually. This command can also be used with the <a href="13-qdoc-commands-topics.html#group-command">\group</a> command to omit the list of group members, when they are listed manually.</p>
<p>The command must stand on its own line. See <a href="../qtsensors/qtsensors-qmlmodule.html">Qt Sensors QML Types</a> for an example. The page is generated from <code>qtsensors5.qdoc</code>. There you will find a qdoc comment containing the <code>\qmlmodule</code> command for the <a href="../qtsensors/qtsensors-module.html">QtSensors</a> module. The same qdoc comment contains two <code>\annotated-list</code> commands to list the QML types in two separate groups. The QML types have been divided into these two groups because it makes more sense to list them this way than it does to list them in a single alphabetical list. At the bottom of the comment, <code>\noautolist</code> has been used to tell qdoc not to generate the automatic annotated list.</p>
<p>This command was introduced in QDoc 5.6&#x2e;</p>
<p>Since Qt 5.10, this command can be applied also to <a href="13-qdoc-commands-topics.html#example-command">\example</a> documentation, where it causes the automatically generated list of files and images belonging to an example project to be omitted.</p>
<a name="omit-command"></a><a name="omit"></a>
<h2 id="omit">\omit</h2>
<p>The \omit command and the corresponding \endomit command delimit parts of the documentation that you want QDoc to skip. For example:</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \table
      \row
          \li Basic Widgets
          \li Basic GUI widgets such as buttons<span class="operator">,</span> comboboxes
             and scrollbars<span class="operator">.</span>

      \omit
      \row
          \li Component Model
          \li Interfaces and helper classes <span class="keyword">for</span> the <span class="type"><a href="../qtcore/qt.html">Qt</a></span>
             Component Model<span class="operator">.</span>
      \endomit

      \row
          \li Database Classes
          \li Database related classes<span class="operator">,</span> e<span class="operator">.</span>g<span class="operator">.</span> <span class="keyword">for</span> SQL databases<span class="operator">.</span>
      \endtable
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>QDoc renders this as:</p>
                <table align="center" cellpadding="2"
                    cellspacing="1" border="0">

                <tr valign="top" bgcolor="#d0d0d0">
                    <td>Basic Widgets</td>
                    <td>Basic GUI widgets such as buttons, comboboxes
                       and scrollbars.</td>
                </tr>

                <tr valign="top" bgcolor="#c0c0c0">
                    <td>Database Classes</td>
                    <td>Database related classes, e.g. for SQL databases.</td>
                </tr>
                </table>
            <a name="raw-command"></a><a name="raw-avoid"></a>
<h2 id="raw-avoid">\raw (avoid)</h2>
<p>The \raw command and the corresponding \endraw command delimit a block of raw mark-up language code.</p>
<p><b>Note: </b>Avoid using this command if possible, because it generates DITA XML code that causes problems. If you are trying to generate special table or list behavior, try to get the behavior you want using the <a href="04-qdoc-commands-textmarkup.html#span-command">\span</a> and <a href="04-qdoc-commands-textmarkup.html#div-command">\div</a> commands in your <a href="10-qdoc-commands-tablesandlists.html#table-command">\table</a> or <a href="10-qdoc-commands-tablesandlists.html#list-command">\list</a>.</p><p>The command takes an argument specifying the code's format. Currently, the only supported format is HTML.</p>
<p>The \raw command is useful if you want some special HTML effects in your documentation.</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      <span class="type"><a href="../qtcore/qt.html">Qt</a></span> has some predefined <span class="type"><a href="../qtgui/qcolor.html">QColor</a></span> objects<span class="operator">.</span>

      \raw HTML
      <span class="operator">&lt;</span>style type<span class="operator">=</span><span class="string">&quot;text/css&quot;</span> id<span class="operator">=</span><span class="string">&quot;colorstyles&quot;</span><span class="operator">&gt;</span>
      <span class="preprocessor">#color-blue { background-color: #0000ff; color: #ffffff }</span>
      <span class="preprocessor">#color-darkBlue { background-color: #000080; color: #ffffff }</span>
      <span class="preprocessor">#color-cyan { background-color: #00ffff; color: #000000 }</span>
      <span class="operator">&lt;</span><span class="operator">/</span>style<span class="operator">&gt;</span>

      <span class="operator">&lt;</span>p<span class="operator">&gt;</span>
      <span class="operator">&lt;</span>tt id<span class="operator">=</span><span class="string">&quot;color-blue&quot;</span><span class="operator">&gt;</span>Blue(<span class="preprocessor">#0000ff)&lt;/tt&gt;,</span>
      <span class="operator">&lt;</span>tt id<span class="operator">=</span><span class="string">&quot;color-darkBlue&quot;</span><span class="operator">&gt;</span>dark blue(<span class="preprocessor">#000080)&lt;/tt&gt; and</span>
      <span class="operator">&lt;</span>tt id<span class="operator">=</span><span class="string">&quot;color-cyan&quot;</span><span class="operator">&gt;</span>cyan(<span class="preprocessor">#00ffff)&lt;/tt&gt;.</span>
  <span class="operator">&lt;</span><span class="operator">/</span>p<span class="operator">&gt;</span>
      \endraw
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>QDoc renders this as:</p>
<blockquote><p>Qt has some predefined <a href="../qtgui/qcolor.html">QColor</a> objects.</p>
               <style type="text/css" id="colorstyles">
               #color-blue { background-color: #0000ff; color: #ffffff }
               #color-darkBlue { background-color: #000080; color: #ffffff }
               #color-cyan { background-color: #00ffff; color: #000000 }
               </style>

               <p>
               <tt id="color-blue">Blue(#0000ff)</tt>,
               <tt id="color-darkBlue">dark blue(#000080)</tt> and
               <tt id="color-cyan">cyan(#00ffff)</tt>.
           </p>
               </blockquote>
<p><b>Note: </b>But you can achieve the exact same thing using qdoc commands. In this case, all you have to do is include the color styles in your style.css file. Then you can write:</p><pre class="cpp">

  \tt {\span {id<span class="operator">=</span><span class="string">&quot;color-blue&quot;</span>} {Blue(<span class="preprocessor">#0000ff)}},</span>
  \tt {\span {id<span class="operator">=</span><span class="string">&quot;color-darkBlue&quot;</span>} {dark blue(<span class="preprocessor">#000080)}} and</span>
  \tt {\span {id<span class="operator">=</span><span class="string">&quot;color-cyan&quot;</span>} {cyan(<span class="preprocessor">#00ffff)}}.</span>

</pre>
<p>...which is rendered as:</p>
<p><code><span id="color-blue">Blue(#0000ff)</span></code>, <code><span id="color-darkBlue">dark blue(#000080)</span></code> and <code><span id="color-cyan">cyan(#00ffff)</span></code>.</p>
<a name="unicode-command"></a><a name="unicode"></a>
<h2 id="unicode">\unicode</h2>
<p>The \unicode command allows you to insert an arbitrary Unicode character in the document.</p>
<p>The command takes an argument specifying the character as an integer. By default, base 10 is assumed, unless a '0x' or '0' prefix is specified (for base 16 and 8, respectively). For example:</p>
<pre class="cpp">

  O G\unicode{<span class="number">0xEA</span>}nio e as Rosas

  \unicode <span class="number">0xC0</span> table en famille avec <span class="number">15</span> \unicode <span class="number">0x20AC</span> par jour

  \unicode <span class="number">0x3A3</span> \e{a}\sub{\e{i}}

</pre>
<p>QDoc renders this as:</p>
<blockquote><p>O Gênio e as Rosas</p>
<p>À table en famille avec 15 € par jour</p>
<p>Σ <i>a</i><sub><i>i</i></sub></p>
</blockquote>
</div>
<!-- @@@12-0-qdoc-commands-miscellaneous.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="11-qdoc-commands-specialcontent.html">Special Content</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="21-0-qdoc-creating-dita-maps.html">Creating DITA Maps</a>
</p>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
